﻿/*
 * Copyright (c) Jason Paul Morley, 2010
 * Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
 */

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Core
{
    /// <summary>
    /// The possible state of an object
    /// </summary>
    public enum State
    {
        /// <summary>
        /// The object is visible and to be displayed
        /// </summary>
        Visible,

        /// <summary>
        /// The object must be highlighted or emphasised in some way
        /// </summary>
        Highlighted,

        /// <summary>
        /// The object must be highlighted or emphasised in some way greater than that of Highlighted
        /// </summary>
        FurtherHighlighted,

        /// <summary>
        /// The object must be highlighted or emphasised in some way greater than that of FurtherHighlighted
        /// </summary>
        MaximumHighlighted,

        /// <summary>
        /// The object has been selected by the user in some manner
        /// </summary>
        Selected,

        /// <summary>
        /// The object is disabled so must be drawn "supressed" or not at all
        /// </summary>
        Disabled,

        /// <summary>
        /// The object is invisible so not to be rendered or represented in any way
        /// </summary>
        Invisible
    }
}
